popuplayout: Add docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 9 Mar 2020 20:36:38 +0000 (13:36 -0700)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 11 Mar 2020 23:35:55 +0000 (19:35 -0400)
gdk/gdkpopuplayout.c

index f612efb7274564ae43ad5684f6ac53c52d1c1712..25f16c5e8a0e0eec0f67420b8669478979e95250 100644 (file)
 
 #include "gdksurface.h"
 
+/**
+ * SECTION:gdkpopuplayout
+ * @Title: GdkPopupLayout
+ * @Short_description: Information for presenting popups
+ *
+ * Popups are positioned relative to their parent surface.
+ * The GdkPopupLayout struct contains information that is
+ * necessary to do so.
+ */
+
 struct _GdkPopupLayout
 {
   /* < private >*/
@@ -200,6 +210,8 @@ gdk_popup_layout_set_rect_anchor (GdkPopupLayout *layout,
  * gdk_popup_layout_get_rect_anchor:
  * @layout: a #GdkPopupLayout
  *
+ * Returns the anchor position on the anchor rectangle.
+ *
  * Returns: the anchor on the anchor rectangle.
  */
 GdkGravity
@@ -226,6 +238,8 @@ gdk_popup_layout_set_surface_anchor (GdkPopupLayout *layout,
  * gdk_popup_layout_get_surface_anchor:
  * @layout: a #GdkPopupLayout
  *
+ * Returns the anchor position on the popup surface.
+ *
  * Returns: the anchor on the popup surface.
  */
 GdkGravity